-
Notifications
You must be signed in to change notification settings - Fork 20
docs: Add an introduction to actors #679
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Based on #667, ignore the first 4 commits. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a couple of cosmetic comments to check for. LGTM!
The merge-base changed after approval.
The merge-base changed after approval.
This function doesn't need to access the `env` object, so it can be defined at the top-level. Signed-off-by: Leandro Lucarella <[email protected]>
This is to encourage users to expand annotations, which might not be that obvious otherwise. Signed-off-by: Leandro Lucarella <[email protected]>
This allows to have a read order for annotations. Signed-off-by: Leandro Lucarella <[email protected]>
This document introduces the actor programming model and how to use it in Frequenz SDK. Signed-off-by: Leandro Lucarella <[email protected]>
The merge-base changed after approval.
|
Investigating an issue with numbered annotations rendering wrongly... |
|
Seems to be an upstream bug: squidfunk/mkdocs-material#6042, so I guess we can proceed hoping it will be fixed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good to me, but at some point, we should write additional sections on requirements, best practices, composition patterns, etc.
|
If you have any specific suggestions I can try to add some of that, it is weird, when I'm coding or reading issues I see a lot of things that it would be good to have in docs, but when I sit down to write docs I get a writers block and I don't know what to put in there 😆 |
|
But I think I will merge this since it is approved so we can keep moving, I can write up any suggestions you make later in a separate PR. |
This new document introduces the actor programming model and how to use it in Frequenz SDK.
Fixes #648.